fix: correct typos and bugs in documentation and scripts#9
Merged
Chen-zexi merged 1 commit intoChen-zexi:mainfrom Dec 3, 2025
Merged
fix: correct typos and bugs in documentation and scripts#9Chen-zexi merged 1 commit intoChen-zexi:mainfrom
Chen-zexi merged 1 commit intoChen-zexi:mainfrom
Conversation
- README.md: Fix typo 'vllm-cl' -> 'vllm-cli' in Basic Usage section - Makefile: Add missing targets to .PHONY declaration (test-cov, format-check, type-check, ci-local, ci-matrix, pre-commit) - scripts/test_ci_locally.sh: Fix pytest-cov detection using Python import instead of shell command - scripts/test_ci_locally.sh: Add Python 3.11+ tomllib compatibility for pyproject.toml validation - docs/profiles.md: Fix grammar 'defaults configuration' -> 'default configuration' - docs/profiles.md: Update VLLM_ATTENTION_BACKEND value to match actual profile usage
Owner
|
Good catch, thanks for your contribution! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This pull request fixes several typos and bugs found in the documentation and build scripts.
Changes
README.md
vllm-clwas missing the trailingi. Changed tovllm-cli.Makefile
.PHONYdeclaration was incomplete. Added missing targets:test-cov,format-check,type-check,ci-local,ci-matrix, andpre-commit. Without proper.PHONYdeclarations, make may skip execution if a file with the same name exists in the directory.scripts/test_ci_locally.sh
command -v pytest-covwhich checks for a shell command, but pytest-cov is a Python package/pytest plugin, not a standalone executable. Changed to usepython -c "import pytest_cov"for proper detection. Also added a skip message when pytest-cov is not installed.tomllib) and earlier Python versions (which require thetomlpackage). The original code only usedimport tomlwhich would fail on Python 3.11+ if thetomlpackage is not installed.docs/profiles.md
Uses vLLM's defaults configurationtoUses vLLM's default configuration(singular form of "default" as adjective).VLLM_ATTENTION_BACKENDenvironment variable reference table. ChangedTRITONtoTRITON_ATTN_VLLM_V1to match the actual value used in thegpt_oss_ampereprofile (line 71).Testing
All changes are documentation and configuration fixes that do not affect runtime behavior. The script fixes improve compatibility across different Python versions and environments.